Skip to main content
POST
/
api
/
v1
/
executions
Triggers the creation of a :ref:`ref_flyteidl.admin.Execution`
curl --request POST \
  --url https://mycluster.domino.tech/api/v1/executions \
  --header 'Content-Type: application/json' \
  --data '
{
  "project": "<string>",
  "domain": "<string>",
  "name": "<string>",
  "spec": {
    "launch_plan": {
      "resource_type": "UNSPECIFIED",
      "project": "<string>",
      "domain": "<string>",
      "name": "<string>",
      "version": "<string>",
      "org": "<string>"
    },
    "inputs": {
      "literals": {}
    },
    "metadata": {
      "mode": "MANUAL",
      "principal": "<string>",
      "nesting": 123,
      "scheduled_at": "2023-11-07T05:31:56Z",
      "parent_node_execution": {
        "node_id": "<string>",
        "execution_id": {
          "project": "<string>",
          "domain": "<string>",
          "name": "<string>",
          "org": "<string>"
        }
      },
      "reference_execution": {
        "project": "<string>",
        "domain": "<string>",
        "name": "<string>",
        "org": "<string>"
      },
      "system_metadata": {
        "execution_cluster": "<string>",
        "namespace": "<string>"
      },
      "artifact_ids": [
        {
          "artifact_key": {
            "project": "<string>",
            "domain": "<string>",
            "name": "<string>",
            "org": "<string>"
          },
          "version": "<string>",
          "partitions": {
            "value": {}
          },
          "time_partition": {
            "value": {
              "static_value": "<string>",
              "time_value": "2023-11-07T05:31:56Z",
              "triggered_binding": {
                "partition_key": "<string>",
                "bind_to_time_partition": true,
                "time_transform": {
                  "transform": "<string>",
                  "op": "MINUS"
                }
              },
              "input_binding": {
                "var": "<string>"
              },
              "runtime_binding": {}
            },
            "granularity": "UNSET"
          }
        }
      ]
    },
    "notifications": {
      "notifications": [
        {
          "phases": [
            "UNDEFINED"
          ],
          "email": {
            "recipients_email": [
              "<string>"
            ],
            "template": "<string>"
          },
          "pager_duty": {
            "recipients_email": [
              "<string>"
            ],
            "template": "<string>"
          },
          "slack": {
            "recipients_email": [
              "<string>"
            ],
            "template": "<string>"
          }
        }
      ]
    },
    "disable_all": true,
    "labels": {
      "values": {}
    },
    "annotations": {
      "values": {}
    },
    "security_context": {
      "run_as": {
        "iam_role": "<string>",
        "k8s_service_account": "<string>",
        "oauth2_client": {
          "client_id": "<string>",
          "client_secret": {
            "group": "<string>",
            "group_version": "<string>",
            "key": "<string>",
            "mount_requirement": "ANY",
            "env_var": "<string>"
          }
        },
        "execution_identity": "<string>"
      },
      "secrets": [
        {
          "group": "<string>",
          "group_version": "<string>",
          "key": "<string>",
          "mount_requirement": "ANY",
          "env_var": "<string>"
        }
      ],
      "tokens": [
        {
          "name": "<string>",
          "type": "CLIENT_CREDENTIALS",
          "client": {
            "client_id": "<string>",
            "client_secret": {
              "group": "<string>",
              "group_version": "<string>",
              "key": "<string>",
              "mount_requirement": "ANY",
              "env_var": "<string>"
            }
          },
          "idp_discovery_endpoint": "<string>",
          "token_endpoint": "<string>"
        }
      ]
    },
    "auth_role": {
      "assumable_iam_role": "<string>",
      "kubernetes_service_account": "<string>"
    },
    "quality_of_service": {
      "tier": "UNDEFINED",
      "spec": {
        "queueing_budget": "<string>"
      }
    },
    "max_parallelism": 123,
    "raw_output_data_config": {
      "output_location_prefix": "<string>"
    },
    "cluster_assignment": {
      "cluster_pool_name": "<string>"
    },
    "interruptible": true,
    "overwrite_cache": true,
    "envs": {
      "values": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    },
    "tags": [
      "<string>"
    ],
    "execution_cluster_label": {
      "value": "<string>"
    },
    "execution_env_assignments": [
      {
        "node_ids": [
          "<string>"
        ],
        "task_type": "<string>",
        "execution_env": {
          "name": "<string>",
          "type": "<string>",
          "extant": {},
          "spec": {},
          "version": "<string>"
        }
      }
    ]
  },
  "inputs": {
    "literals": {}
  },
  "org": "<string>"
}
'
{
  "id": {
    "project": "<string>",
    "domain": "<string>",
    "name": "<string>",
    "org": "<string>"
  }
}

Body

application/json

Request to launch an execution with the given project, domain and optionally-assigned name.

Request to launch an execution with the given project, domain and optionally-assigned name.

project
string
domain
string
name
string
spec
object

An ExecutionSpec encompasses all data used to launch this execution. The Spec does not change over the lifetime of an execution as it progresses across phase changes.

inputs
object

A map of literals. This is a workaround since oneofs in proto messages cannot contain a repeated field.

org
string

Optional, org key applied to the resource.

Response

A successful response.

The unique identifier for a successfully created execution. If the name was not specified in the create request, this identifier will include a generated name.

id
Encapsulation of fields that uniquely identifies a Flyte workflow execution · object